/*
 * #%L
 * Server
 * %%
 * Copyright (C) 2011 Ractoc.com
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.ractoc.opengamefinder.server.plugins.messages;

import com.ractoc.pffj.api.BasePluginMessage;

/**
 * Retrieves a previously stored Session variable from the supplied session id.
 * @author ractoc
 * @version 0.1
 */
public final class RetrieveSessionValueMessage extends BasePluginMessage {

    private Integer sessionId;

    private String key;
    
    /**
     * Default constructor.
     */
    public RetrieveSessionValueMessage() {
    }

    /**
     * Get the session id for the session the variable needs to be collected frmo.
     * @return The session if for the session the variable needs to be collected from.
     */
    public Integer getSessionId() {
        return sessionId;
    }

    /**
     * Set the session id for the session the variable needs to be collected frmo.
     * @param sessionIdParam The session if for the session the variable needs to be collected from.
     */
    public void setSessionId(final Integer sessionIdParam) {
        this.sessionId = sessionIdParam;
    }

    /**
     * Get the key which identifies the variable that needs to be retrieved.
     * @return The key which identifies the variable that needs to be retrieved.
     */
    public String getKey() {
        return key;
    }

    /**
     * set the key which identifies the variable that needs to be retrieved.
     * @param keyParam The key which identifies the variable that needs to be retrieved.
     */
    public void setKey(final String keyParam) {
        this.key = keyParam;
    }

}
